-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Move demo to docs #1161
Move demo to docs #1161
Conversation
We should probably also link to the demo page in the docs/README.md |
@UziTech I almost forgot! I made a bunch of changes including "Add link to demo from readme" Thanks 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Might be nice to make the two READMEs the same. Feels weird to me to have the README on the main repo - then see a more robust and complete one on the site; especially given the main README is the one posted to NPM. The links and everything should be able to remain the same. |
@joshbruce Yes I understand this might be a little confusing. But the idea is to not be publishing MB of data to npm because users who run However, it is a good starting point for people coming to the github page or npm page so they at least see one example usage and a link to the full docs. Maybe the confusion can be avoided if we rename |
@styfle: That's fair, and pretty understandable. I think I'm looking at it from the perspective of what is the minimum information a new developer would need or want to get started and optionally dive into higher levels of complexity. So, I think the README.md could be used without having a duplicated file in the |
Move demo to docs
This PR adds a demo page to the docs.
Note: this is continued work from #64
Contributor
Committer
In most cases, this should be a different person than the contributor.